Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC update document references & include summary for papers at home page #104

Merged
merged 3 commits into from
Aug 7, 2023
Merged

DOC update document references & include summary for papers at home page #104

merged 3 commits into from
Aug 7, 2023

Conversation

PSSF23
Copy link
Member

@PSSF23 PSSF23 commented Aug 7, 2023

Before submitting

  • I've read and followed all steps in the Making a pull request
    section of the CONTRIBUTING docs.
  • I've updated or added any relevant docstrings following the syntax described in the
    Writing docstrings section of the CONTRIBUTING docs.
  • If this PR fixes a bug, I've added a test that will fail without my fix.
  • If this PR adds a new feature, I've added tests that sufficiently cover my new functionality.

After submitting

  • All GitHub Actions jobs for my pull request have passed.

@PSSF23 PSSF23 requested a review from adam2392 August 7, 2023 14:17
adam2392
adam2392 approved these changes Aug 7, 2023
View reviewed changes
Copy link
Collaborator

@adam2392 adam2392 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

PSSF23
PSSF23 commented Aug 7, 2023
View reviewed changes
Copy link
Member Author

@PSSF23 PSSF23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: add document that outlines all the relevant papers included in the package (per jovo).

@adam2392 Where you feel this document should be? Or should I update the home page to include such information?

@adam2392
Copy link
Collaborator

adam2392 commented Aug 7, 2023

Sure you can add to homepage.

For example: we have unsupervised forest, sporf, morf and uncertainty forest.

W/ #75 we can also have extended isolation forest.

@PSSF23 PSSF23 changed the title DOC update document references for SPORF and MORF DOC update document references & include summary for papers at home page Aug 7, 2023
PSSF23
PSSF23 commented Aug 7, 2023
View reviewed changes
Copy link
Member Author

@PSSF23 PSSF23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested html locally. @adam2392 Are the build errors expected?

@adam2392
Copy link
Collaborator

adam2392 commented Aug 7, 2023

Yes there was an error on main I didn't catch or the CIs. I fixed it in #94

But I can just merge this in first.

@adam2392 adam2392 merged commit b44c951 into main Aug 7, 2023
3 of 23 checks passed
@adam2392
Copy link
Collaborator

adam2392 commented Aug 7, 2023

Thanks @PSSF23 !

@adam2392 adam2392 deleted the doc branch August 7, 2023 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adam2392 adam2392 adam2392 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PSSF23 @adam2392